﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System.Collections.Generic;
using ScrumTable.DL.Data.Schema;

#endregion

namespace ScrumTable.DL.Data.Common
{
    /// <summary>
    /// Gets or sets the internal data state of a DataObject. The
    /// state contains all values which are required to restore
    /// a data object.
    /// </summary>
    public interface IDataObjectState
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the ID of the current data object.
        /// </summary>
        string Id { get; }

        /// <summary>
        /// Gets the underlying system order index. This property can be used
        /// to output the elements in the order given by the data connector.
        /// </summary>
        double OrderIndex { get; }

        /// <summary>
        /// Gets or sets the internal data values.
        /// </summary>
        IDictionary<string, object> State { get; }

        /// <summary>
        /// Gets the schema of the underlying data object fields.
        /// </summary>
        SchemaBase Schema { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}